Update docs #14
Update docs #14
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project documentation to better explain the Hugo Guides Module's purpose and functionality. The changes transform the basic repository description into comprehensive documentation that explains the module's capabilities for multi-language, multi-version guide publishing.
- Updated the main readme with detailed module description, features, and example implementations
- Added instruction files for different components (site, module, powershell) to guide development and usage
- Provided concrete examples of sites currently using this module
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| readme.md | Enhanced with comprehensive module description, features, translation capabilities, and real-world usage examples |
| .github/instructions/site.instructions.md | Added documentation for the demo site used for local debugging and development |
| .github/instructions/powershell.instructions.md | Added documentation for PowerShell setup scripts for multi-lingual Hugo sites |
| .github/instructions/module.instructions.md | Added module-specific documentation explaining core functionality and translation features |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| applyTo: ".powershell/**" | ||
| --- | ||
|
|
||
| These are demo powershell scripts for seting up the multi-lingual and other options for the Hugo sites that depend on this Module |
There was a problem hiding this comment.
There is a spelling error: 'seting' should be 'setting'.
| These are demo powershell scripts for seting up the multi-lingual and other options for the Hugo sites that depend on this Module | |
| These are demo powershell scripts for setting up the multi-lingual and other options for the Hugo sites that depend on this Module |
|
|
||
| - [Kanban Guides](https://kanbanguides.org) – [GitHub](https://github.com/KanbanGuides/KanbanGuides) | ||
| - [Scrum Expansion Pack](https://scrumexpansion.org) – [GitHub](https://github.com/ScrumGuides/ScrumGuide-ExpansionPack) | ||
| - [Safe Delusion](https://safedelusion.com) – |
There was a problem hiding this comment.
The Safe Delusion entry appears incomplete - it's missing the GitHub link that the other entries have, and ends with just a dash.
| - [Safe Delusion](https://safedelusion.com) – | |
| - [Safe Delusion](https://safedelusion.com) |
No description provided.